Entity Ammo
Ammo is the Entity definition for an ammunition object.
Subclass of Collectable.
Functions
| GetType () | GetType returns the type of ammo this entity provides (e.g. |
| GetVariant () | GetVariant returns the variant of ammo this entity provides (e.g. |
| GetPrimaryDamageType () | GetPrimaryDamageType returns the main damage type this ammo will cause (e.g. |
| GetSecondaryDamageType () | GetSecondaryDamageType returns the secondary damage type this ammo will cause, if any (e.g. |
| GetImpactFX () | GetImpactFX returns the sprite effect shown on impact when this ammo is used. |
| GetImpactSoundFX () | GetImpactSoundFX returns the sound effect played on impact when this ammo is used. |
Functions
- GetType ()
-
GetType returns the type of ammo this entity provides (e.g. "9mm").
Returns:
-
A string indicating the ammo type.
- GetVariant ()
-
GetVariant returns the variant of ammo this entity provides (e.g. "JHP").
Returns:
-
A string indicating the ammo variant.
- GetPrimaryDamageType ()
-
GetPrimaryDamageType returns the main damage type this ammo will cause (e.g. "energy").
Returns:
-
A string indicating the main dmaage type.
- GetSecondaryDamageType ()
-
GetSecondaryDamageType returns the secondary damage type this ammo will cause, if any (e.g. "poison").
Returns:
-
A string indicating the secondary dmaage type, or "normal" if none.
- GetImpactFX ()
-
GetImpactFX returns the sprite effect shown on impact when this ammo is used.
Returns:
-
A string indicating the impact FX type.
- GetImpactSoundFX ()
-
GetImpactSoundFX returns the sound effect played on impact when this ammo is used.
Returns:
-
A string indicating the impact sound FX.